home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / src / linux-headers-2.6.28-15 / include / linux / sunrpc / auth.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-12-24  |  5.1 KB  |  166 lines
  1. /*
  2.  * linux/include/linux/sunrpc/auth.h
  3.  *
  4.  * Declarations for the RPC client authentication machinery.
  5.  *
  6.  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
  7.  */
  8.  
  9. #ifndef _LINUX_SUNRPC_AUTH_H
  10. #define _LINUX_SUNRPC_AUTH_H
  11.  
  12. #ifdef __KERNEL__
  13.  
  14. #include <linux/sunrpc/sched.h>
  15. #include <linux/sunrpc/msg_prot.h>
  16. #include <linux/sunrpc/xdr.h>
  17.  
  18. #include <asm/atomic.h>
  19. #include <linux/rcupdate.h>
  20.  
  21. /* size of the nodename buffer */
  22. #define UNX_MAXNODENAME    32
  23.  
  24. /* Work around the lack of a VFS credential */
  25. struct auth_cred {
  26.     uid_t    uid;
  27.     gid_t    gid;
  28.     struct group_info *group_info;
  29.     unsigned char machine_cred : 1;
  30. };
  31.  
  32. /*
  33.  * Client user credentials
  34.  */
  35. struct rpc_auth;
  36. struct rpc_credops;
  37. struct rpc_cred {
  38.     struct hlist_node    cr_hash;    /* hash chain */
  39.     struct list_head    cr_lru;        /* lru garbage collection */
  40.     struct rcu_head        cr_rcu;
  41.     struct rpc_auth *    cr_auth;
  42.     const struct rpc_credops *cr_ops;
  43. #ifdef RPC_DEBUG
  44.     unsigned long        cr_magic;    /* 0x0f4aa4f0 */
  45. #endif
  46.     unsigned long        cr_expire;    /* when to gc */
  47.     unsigned long        cr_flags;    /* various flags */
  48.     atomic_t        cr_count;    /* ref count */
  49.  
  50.     uid_t            cr_uid;
  51.  
  52.     /* per-flavor data */
  53. };
  54. #define RPCAUTH_CRED_NEW    0
  55. #define RPCAUTH_CRED_UPTODATE    1
  56. #define RPCAUTH_CRED_HASHED    2
  57.  
  58. #define RPCAUTH_CRED_MAGIC    0x0f4aa4f0
  59.  
  60. /*
  61.  * Client authentication handle
  62.  */
  63. #define RPC_CREDCACHE_HASHBITS    4
  64. #define RPC_CREDCACHE_NR    (1 << RPC_CREDCACHE_HASHBITS)
  65. struct rpc_cred_cache {
  66.     struct hlist_head    hashtable[RPC_CREDCACHE_NR];
  67.     spinlock_t        lock;
  68. };
  69.  
  70. struct rpc_authops;
  71. struct rpc_auth {
  72.     unsigned int        au_cslack;    /* call cred size estimate */
  73.                 /* guess at number of u32's auth adds before
  74.                  * reply data; normally the verifier size: */
  75.     unsigned int        au_rslack;
  76.                 /* for gss, used to calculate au_rslack: */
  77.     unsigned int        au_verfsize;
  78.  
  79.     unsigned int        au_flags;    /* various flags */
  80.     const struct rpc_authops *au_ops;        /* operations */
  81.     rpc_authflavor_t    au_flavor;    /* pseudoflavor (note may
  82.                          * differ from the flavor in
  83.                          * au_ops->au_flavor in gss
  84.                          * case) */
  85.     atomic_t        au_count;    /* Reference counter */
  86.  
  87.     struct rpc_cred_cache *    au_credcache;
  88.     /* per-flavor data */
  89. };
  90.  
  91. /* Flags for rpcauth_lookupcred() */
  92. #define RPCAUTH_LOOKUP_NEW        0x01    /* Accept an uninitialised cred */
  93.  
  94. /*
  95.  * Client authentication ops
  96.  */
  97. struct rpc_authops {
  98.     struct module        *owner;
  99.     rpc_authflavor_t    au_flavor;    /* flavor (RPC_AUTH_*) */
  100.     char *            au_name;
  101.     struct rpc_auth *    (*create)(struct rpc_clnt *, rpc_authflavor_t);
  102.     void            (*destroy)(struct rpc_auth *);
  103.  
  104.     struct rpc_cred *    (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
  105.     struct rpc_cred *    (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
  106. };
  107.  
  108. struct rpc_credops {
  109.     const char *        cr_name;    /* Name of the auth flavour */
  110.     int            (*cr_init)(struct rpc_auth *, struct rpc_cred *);
  111.     void            (*crdestroy)(struct rpc_cred *);
  112.  
  113.     int            (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
  114.     void            (*crbind)(struct rpc_task *, struct rpc_cred *);
  115.     __be32 *        (*crmarshal)(struct rpc_task *, __be32 *);
  116.     int            (*crrefresh)(struct rpc_task *);
  117.     __be32 *        (*crvalidate)(struct rpc_task *, __be32 *);
  118.     int            (*crwrap_req)(struct rpc_task *, kxdrproc_t,
  119.                         void *, __be32 *, void *);
  120.     int            (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
  121.                         void *, __be32 *, void *);
  122. };
  123.  
  124. extern const struct rpc_authops    authunix_ops;
  125. extern const struct rpc_authops    authnull_ops;
  126.  
  127. void __init        rpc_init_authunix(void);
  128. void __init        rpc_init_generic_auth(void);
  129. void __init        rpcauth_init_module(void);
  130. void __exit        rpcauth_remove_module(void);
  131. void __exit        rpc_destroy_generic_auth(void);
  132.  
  133. struct rpc_cred *    rpc_lookup_cred(void);
  134. struct rpc_cred *    rpc_lookup_machine_cred(void);
  135. int            rpcauth_register(const struct rpc_authops *);
  136. int            rpcauth_unregister(const struct rpc_authops *);
  137. struct rpc_auth *    rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
  138. void            rpcauth_release(struct rpc_auth *);
  139. struct rpc_cred *    rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
  140. void            rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
  141. struct rpc_cred *    rpcauth_lookupcred(struct rpc_auth *, int);
  142. void            rpcauth_bindcred(struct rpc_task *, struct rpc_cred *, int);
  143. void            rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *);
  144. void            put_rpccred(struct rpc_cred *);
  145. void            rpcauth_unbindcred(struct rpc_task *);
  146. __be32 *        rpcauth_marshcred(struct rpc_task *, __be32 *);
  147. __be32 *        rpcauth_checkverf(struct rpc_task *, __be32 *);
  148. int            rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
  149. int            rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj);
  150. int            rpcauth_refreshcred(struct rpc_task *);
  151. void            rpcauth_invalcred(struct rpc_task *);
  152. int            rpcauth_uptodatecred(struct rpc_task *);
  153. int            rpcauth_init_credcache(struct rpc_auth *);
  154. void            rpcauth_destroy_credcache(struct rpc_auth *);
  155. void            rpcauth_clear_credcache(struct rpc_cred_cache *);
  156.  
  157. static inline
  158. struct rpc_cred *    get_rpccred(struct rpc_cred *cred)
  159. {
  160.     atomic_inc(&cred->cr_count);
  161.     return cred;
  162. }
  163.  
  164. #endif /* __KERNEL__ */
  165. #endif /* _LINUX_SUNRPC_AUTH_H */
  166.